home *** CD-ROM | disk | FTP | other *** search
/ CD Actual 85 / CD Actual 85 Febrero 2004.iso / Experto / Apache / apache_2.0.48-win32-x86-no_ssl.msi / Data.Cab / F252673_mod_auth_dbm.xml < prev    next >
Encoding:
Extensible Markup Language  |  2003-04-15  |  8.3 KB  |  195 lines
  1. <?xml version="1.0"?>
  2. <!DOCTYPE modulesynopsis SYSTEM "../style/modulesynopsis.dtd">
  3. <?xml-stylesheet type="text/xsl" href="../style/manual.en.xsl"?>
  4. <modulesynopsis metafile="mod_auth_dbm.xml.meta">
  5.  
  6. <name>mod_auth_dbm</name>
  7. <description>Provides for user authentication using DBM
  8.     files</description>
  9. <status>Extension</status>
  10. <sourcefile>mod_auth_dbm.c</sourcefile>
  11. <identifier>auth_dbm_module</identifier>
  12. <compatibility>Available only in versions prior to 2.1</compatibility>
  13.  
  14. <summary>
  15.     <p>This module provides for HTTP Basic Authentication, where
  16.     the usernames and passwords are stored in DBM type database
  17.     files. It is an alternative to the plain text password files
  18.     provided by <module>mod_auth</module>.</p>
  19. </summary>
  20.  
  21. <seealso><directive module="core">AuthName</directive></seealso>
  22. <seealso><directive module="core">AuthType</directive></seealso>
  23. <seealso><directive module="core">Require</directive></seealso>
  24. <seealso><directive module="core">Satisfy</directive></seealso>
  25.  
  26. <directivesynopsis>
  27. <name>AuthDBMGroupFile</name>
  28. <description>Sets the name of the database file containing the list
  29. of user groups for authentication</description>
  30. <syntax>AuthDBMGroupFile <var>file-path</var></syntax>
  31. <contextlist><context>directory</context><context>.htaccess</context>
  32. </contextlist>
  33. <override>AuthConfig</override>
  34.  
  35. <usage>
  36.     <p>The <directive>AuthDBMGroupFile</directive> directive sets the
  37.     name of a DBM file containing the list of user groups for user
  38.     authentication. <var>File-path</var> is the absolute path to the
  39.     group file.</p>
  40.  
  41.     <p>The group file is keyed on the username. The value for a
  42.     user is a comma-separated list of the groups to which the users
  43.     belongs. There must be no whitespace within the value, and it
  44.     must never contain any colons.</p>
  45.  
  46.     <p>Security: make sure that the
  47.     <directive>AuthDBMGroupFile</directive> is stored outside the
  48.     document tree of the web-server; do <em>not</em> put it in the
  49.     directory that it protects. Otherwise, clients will be able to
  50.     download the <directive>AuthDBMGroupFile</directive> unless
  51.     otherwise protected.</p>
  52.  
  53.     <p>Combining Group and Password DBM files: In some cases it is
  54.     easier to manage a single database which contains both the
  55.     password and group details for each user. This simplifies any
  56.     support programs that need to be written: they now only have to
  57.     deal with writing to and locking a single DBM file. This can be
  58.     accomplished by first setting the group and password files to
  59.     point to the same DBM:</p>
  60.  
  61.     <example>
  62.       AuthDBMGroupFile /www/userbase<br />
  63.       AuthDBMUserFile /www/userbase
  64.     </example>
  65.  
  66.     <p>The key for the single DBM is the username. The value consists
  67.     of</p>
  68.  
  69.     <example>
  70.       <var>Unix Crypt-ed Password</var>:<var>List of Groups</var>[:(ignored)]
  71.     </example>
  72.  
  73.     <p>The password section contains the encrypted password as before.
  74.     This is followed by a colon and the comma separated list of groups.
  75.     Other data may optionally be left in the DBM file after another colon;
  76.     it is ignored by the authentication module. This is what
  77.     www.telescope.org uses for its combined password and group database.</p>
  78. </usage>
  79. </directivesynopsis>
  80.  
  81. <directivesynopsis>
  82. <name>AuthDBMUserFile</name>
  83. <description>Sets thename of a database file containing the list of users and
  84. passwords for authentication</description>
  85. <syntax>AuthDBMUserFile <var>file-path</var></syntax>
  86. <contextlist><context>directory</context><context>.htaccess</context>
  87. </contextlist>
  88. <override>AuthConfig</override>
  89.  
  90. <usage>
  91.     <p>The <directive>AuthDBMUserFile</directive> directive sets the
  92.     name of a DBM file containing the list of users and passwords for
  93.     user authentication. <var>File-path</var> is the absolute path to
  94.     the user file.</p>
  95.  
  96.     <p>The user file is keyed on the username. The value for a user is
  97.     the encrypted password, optionally followed by a colon and arbitrary
  98.     data. The colon and the data following it will be ignored by the
  99.     server.</p>
  100.  
  101.     <note type="warning"><title>Security:</title>
  102.       <p>Make sure that the <directive>AuthDBMUserFile</directive> is stored
  103.       outside the document tree of the web-server; do <em>not</em> put it in
  104.       the directory that it protects. Otherwise, clients will be able to
  105.       download the <directive>AuthDBMUserFile</directive>.</p>
  106.     </note>
  107.  
  108.     <p>Important compatibility note: The implementation of
  109.     "dbmopen" in the apache modules reads the string length of the
  110.     hashed values from the DBM data structures, rather than relying
  111.     upon the string being NULL-appended. Some applications, such as
  112.     the Netscape web server, rely upon the string being
  113.     NULL-appended, so if you are having trouble using DBM files
  114.     interchangeably between applications this may be a part of the
  115.     problem.</p>
  116.  
  117.     <p>A perl script called
  118.     <a href="../programs/dbmmanage.html">dbmmanage</a> is included with
  119.     Apache. This program can be used to create and update DBM
  120.     format password files for use with this module.</p>
  121. </usage>
  122. </directivesynopsis>
  123.  
  124. <directivesynopsis>
  125. <name>AuthDBMType</name>
  126. <description>Sets the type of database file that is used to
  127. store passwords</description>
  128. <syntax>AuthDBMType default|SDBM|GDBM|NDBM|DB</syntax>
  129. <default>AuthDBMType default</default>
  130. <contextlist><context>directory</context><context>.htaccess</context>
  131. </contextlist>
  132. <override>AuthConfig</override>
  133. <compatibility>Available in version 2.0.30 and later.</compatibility>
  134.  
  135. <usage>
  136.     <p>Sets the type of database file that is used to store the passwords.
  137.     The default database type is determined at compile time.  The
  138.     availability of other types of database files also depends on
  139.     <a href="../install.html#dbm">compile-time settings</a>.</p>
  140.  
  141.     <p>It is crucial that whatever program you use to create your password
  142.     files is configured to use the same type of database.</p>
  143. </usage>
  144. </directivesynopsis>
  145.  
  146. <directivesynopsis>
  147. <name>AuthDBMAuthoritative</name>
  148. <description>Sets whether authentication and authorization will be
  149. passwed on to lower level modules</description>
  150. <syntax>AuthDBMAuthoritative On|Off</syntax>
  151. <default>AuthDBMAuthoritative On</default>
  152. <contextlist><context>directory</context><context>.htaccess</context>
  153. </contextlist>
  154. <override>AuthConfig</override>
  155.  
  156. <usage>
  157.     <p>Setting the <directive>AuthDBMAuthoritative</directive>
  158.     directive explicitly to <code>Off</code> allows for both
  159.     authentication and authorization to be passed on to lower level
  160.     modules (as defined in the <code>modules.c</code> files) if there
  161.     is <strong>no userID</strong> or <strong>rule</strong> matching the
  162.     supplied userID. If there is a userID and/or rule specified; the
  163.     usual password and access checks will be applied and a failure will
  164.     give an "Authentication Required" reply.</p>
  165.  
  166.     <p>So if a userID appears in the database of more than one module;
  167.     or if a valid <directive module="core">Require</directive>
  168.     directive applies to more than one module; then the first module
  169.     will verify the credentials; and no access is passed on;
  170.     regardless of the <directive>AuthDBMAuthoritative</directive>
  171.     setting.</p>
  172.  
  173.     <p>A common use for this is in conjunction with one of the
  174.     basic auth modules; such as <module>mod_auth</module>. Whereas this
  175.     DBM module supplies the bulk of the user credential checking; a
  176.     few (administrator) related accesses fall through to a lower
  177.     level with a well protected <code>.htpasswd</code> file.</p>
  178.  
  179.     <p>By default, control is not passed on and an unknown userID
  180.     or rule will result in an "Authentication Required" reply. Not
  181.     setting it thus keeps the system secure and forces an NCSA
  182.     compliant behaviour.</p>
  183.  
  184.     <note type="warning"><title>Security:</title>
  185.       <p>Do consider the implications of allowing a user to allow
  186.       fall-through in his <code>.htaccess</code> file; and verify that this
  187.       is really what you want; Generally it is easier to just secure
  188.       a single <code>.htpasswd</code> file, than it is to secure a
  189.       database which might have more access interfaces.</p>
  190.     </note>
  191. </usage>
  192. </directivesynopsis>
  193.  
  194. </modulesynopsis>
  195.